Skip to content

[ENH] Allow additional columns if defined for various TSV files #2054

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 22, 2025

Conversation

effigies
Copy link
Collaborator

Several table definitions were missing an indication of whether additional columns were allowed, which defaults to not_allowed. This PR updates the metaschema to require the field to be explicit, and sets its value to allowed_if_defined for all cases that were missing.

cc @melanieganz @CPernet @mnoergaard for your thoughts on the PET cases. This is strictly speaking a relaxation, but IMO if people provide definitions, that's good?

Closes #1993.

@effigies
Copy link
Collaborator Author

@yarikoptic Could I trouble you for a review? I suspect most of our European friends are on holiday, you seem active, and I think this should be straightforward.

@@ -21,6 +21,7 @@ Blood:
whole_blood_radioactivity:
level: optional
level_addendum: required if `WholeBloodAvail` is `true`
additional_columns: allowed_if_defined
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mnoergaard @melanieganz Can you confirm whether blood.tsv files are permitted to have unknown columns? The options are allowed (warn if undefined by BIDS spec or sidecar), allowed_if_defined (error if undefined by BIDS spec or sidecar), and not_allowed (error if undefined by BIDS spec).

@effigies effigies force-pushed the fix/segmentation-tsv branch from 42bb79a to 1125fd2 Compare May 22, 2025 19:33
Copy link

codecov bot commented May 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.06%. Comparing base (4b2c5d3) to head (19cf2f4).
Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2054   +/-   ##
=======================================
  Coverage   82.06%   82.06%           
=======================================
  Files          17       17           
  Lines        1533     1533           
=======================================
  Hits         1258     1258           
  Misses        275      275           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@effigies effigies force-pushed the fix/segmentation-tsv branch from 1125fd2 to 19cf2f4 Compare May 22, 2025 19:43
@effigies effigies requested a review from rwblair May 22, 2025 19:43
@rwblair rwblair merged commit 03a0626 into bids-standard:master May 22, 2025
27 checks passed
@effigies effigies deleted the fix/segmentation-tsv branch May 22, 2025 19:50
effigies added a commit that referenced this pull request May 22, 2025
metaschema: Require additional_columns field for tables
schema: Define missing additional columns
fix: Add initial_columns to blood.tsv rule to match spec
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

TSV lookup tables for segmentation do not allow extra columns
3 participants